TPT API

The TPT API is used to remote-control TPT via other programs. To use the TPT API, include the <TPT installation path>\public\tptapi.jar in your Java project.

Documentation

To open the TPT API documentation, select TPT API in Views|Show view|Help. Click Help to get an overview about the organization of this documentation, see Figure " Open the description of the TPT API organization"

Open the description of the TPT API organization

Plug-ins

To use the TPT API, the "TPT Programming API for Remote Access" plug-in must be activated. To check if the TPT API plug-in is already activated, click Help|About TPT and look for "apiserver" in the Loaded Plugins section.

Loaded plug-ins

If the "apiserver" plug-in is not activated, open the TPT Tool Preferences (Options|Preferences|General|Plug-Ins) and select TPT Programming API for Remote Access. If you cannot activate the plug-in, contact PikeTec.

If the plug-in is activated, go to TPT API in the TPT Tool Preferences and select the Enable TPT API (RMI) checkbox and enter a RMI binding name and a Port, see General Preferences - TPT API.

There are two examples available in <TPT installation folder>\examples\TPT API\api-example.zip.

These examples show how to model a test case (ExampleTestModeling.java) and how to execute test sets (ExampleTestExecution.java), see the Readme.txt file for more information.